<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
  <head>
    <title>
Bugzilla::Whine::Schedule</title>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
  <link rel="stylesheet" title="style" type="text/css" href="../.././../../../style.css" media="all" >

</head>
  <body id="pod">
<p class="backlinktop"><b><a name="___top" href="../../index.html" accesskey="1" title="All Documents">&lt;&lt;</a></b></p>
<h1>Bugzilla::Whine::Schedule</h1>
<div class='indexgroup'>
<ul   class='indexList indexList1'>
  <li class='indexItem indexItem1'><a href='#NAME'>NAME</a>
  <li class='indexItem indexItem1'><a href='#SYNOPSIS'>SYNOPSIS</a>
  <li class='indexItem indexItem1'><a href='#DESCRIPTION'>DESCRIPTION</a>
  <li class='indexItem indexItem1'><a href='#METHODS'>METHODS</a>
  <ul   class='indexList indexList2'>
    <li class='indexItem indexItem2'><a href='#Constructors'>Constructors</a>
    <li class='indexItem indexItem2'><a href='#Accessors'>Accessors</a>
  </ul>
</ul>
</div>

<h1><a class='u' href='#___top' title='click to go to top of document'
name="NAME"
>NAME</a></h1>

<p>Bugzilla::Whine::Schedule - A schedule object used by <a href="../../Bugzilla/Whine.html" class="podlinkpod"
>Bugzilla::Whine</a>.</p>

<h1><a class='u' href='#___top' title='click to go to top of document'
name="SYNOPSIS"
>SYNOPSIS</a></h1>

<pre  class="code"> use Bugzilla::Whine::Schedule;

 my $schedule = new Bugzilla::Whine::Schedule($schedule_id);

 my $event_id    = $schedule-&#62;eventid;
 my $run_day     = $schedule-&#62;run_day;
 my $run_time    = $schedule-&#62;run_time;
 my $is_group    = $schedule-&#62;mailto_is_group;
 my $object      = $schedule-&#62;mailto;
 my $array_ref   = $schedule-&#62;mailto_users;</pre>

<h1><a class='u' href='#___top' title='click to go to top of document'
name="DESCRIPTION"
>DESCRIPTION</a></h1>

<p>This module exists to represent a <a href="../../Bugzilla/Whine.html" class="podlinkpod"
>Bugzilla::Whine</a> event schedule.</p>

<p>This is an implementation of <a href="../../Bugzilla/Object.html" class="podlinkpod"
>Bugzilla::Object</a>, and so has all the same methods available as <a href="../../Bugzilla/Object.html" class="podlinkpod"
>Bugzilla::Object</a>, in addition to what is documented below.</p>

<h1><a class='u' href='#___top' title='click to go to top of document'
name="METHODS"
>METHODS</a></h1>

<h2><a class='u' href='#___top' title='click to go to top of document'
name="Constructors"
>Constructors</a></h2>

<dl>
<dt><a name="new"
><code  class="code">new</code></a></dt>

<dd>
<p>Does not accept a bare <code  class="code">name</code> argument. Instead, accepts only an id.</p>

<p>See also: <a href="../../Bugzilla/Object.html#new" class="podlinkpod"
>&#34;new&#34; in Bugzilla::Object</a>.</p>
</dd>
</dl>

<h2><a class='u' href='#___top' title='click to go to top of document'
name="Accessors"
>Accessors</a></h2>

<p>These return data about the object, without modifying the object.</p>

<dl>
<dt><a name="event_id"
><code  class="code">event_id</code></a></dt>

<dd>
<p>The <a href="../../Bugzilla/Whine.html" class="podlinkpod"
>Bugzilla::Whine</a> event object id for this object.</p>

<dt><a name="run_day"
><code  class="code">run_day</code></a></dt>

<dd>
<p>The day or day pattern that a <a href="../../Bugzilla/Whine.html" class="podlinkpod"
>Bugzilla::Whine</a> event is scheduled to run.</p>

<dt><a name="run_time"
><code  class="code">run_time</code></a></dt>

<dd>
<p>The time or time pattern that a <a href="../../Bugzilla/Whine.html" class="podlinkpod"
>Bugzilla::Whine</a> event is scheduled to run.</p>

<dt><a name="mailto_is_group"
><code  class="code">mailto_is_group</code></a></dt>

<dd>
<p>Returns a numeric 1 (<code  class="code">group</code>) or 0 (<code  class="code">user</code>) to represent whether <a href="#mailto" class="podlinkpod"
>&#34;mailto&#34;</a> is a group or user.</p>

<dt><a name="mailto"
><code  class="code">mailto</code></a></dt>

<dd>
<p>This is either a <a href="../../Bugzilla/User.html" class="podlinkpod"
>Bugzilla::User</a> or <a href="../../Bugzilla/Group.html" class="podlinkpod"
>Bugzilla::Group</a> object to represent the user or group this scheduled event is set to be mailed to.</p>

<dt><a name="mailto_users"
><code  class="code">mailto_users</code></a></dt>

<dd>
<p>Returns an array reference of <a href="../../Bugzilla/User.html" class="podlinkpod"
>Bugzilla::User</a>s. This is derived from the <a href="../../Bugzilla/Group.html" class="podlinkpod"
>Bugzilla::Group</a> stored in <a href="#mailto" class="podlinkpod"
>&#34;mailto&#34;</a> if <a href="#mailto_is_group" class="podlinkpod"
>&#34;mailto_is_group&#34;</a> is true and the group is still active, otherwise it will contain a single array element for the <a href="../../Bugzilla/User.html" class="podlinkpod"
>Bugzilla::User</a> in <a href="#mailto" class="podlinkpod"
>&#34;mailto&#34;</a>.</p>
</dd>
</dl>
<p class="backlinkbottom"><b><a name="___bottom" href="../../index.html" title="All Documents">&lt;&lt;</a></b></p>

<!-- end doc -->

</body></html>
